efa auth user

Configure users with CLI.

Syntax

efa auth user add [ --userName string --emailID string --roles string --isBlock { true | false} --password string --organization string --mobileNumber string]

Note

--userName, --emailID, --roles and --password are mandatory parameters.

efa auth user show [ --userName string ]

efa auth user show-active [ --authType {TACACS | LDAP | LOCAL | HOST } ]

efa auth user delete [ --userName string ]

efa auth user update [ --userName string | --roles string | --mobileNumber string | organization string ]

efa auth user block-unblock [ --userName string --isBlock { true | false} ]

efa auth user reset-password [ --userName string --emailID string --password string ]

efa auth user change-password [ --userName string --oldPassword string--newPassword string ]

Parameters

--authType { TACACS | LDAP | LOCAL | HOST }: Specifies the authentication type of the active users to list.
--emailID string: Specifies the email address of the user to configure.
--isBlock { true | false}: Specifies the isBlock status of the user.
--mobileNumber string: Specifies the mobile number of the user.
--newPassword string: Specifies the new password for the user.
--oldPassword string: Specifies the old password for the user.
--organization string: Specifies the organization the user belong to.
--password string: Specifies the password for the user.
--roles string: Specifies the comma separated list of roles to assign to the user.
--userName string: Specifies the user name to configure.

Examples

This example adds a new user, specifying user name, user email address, password, roles, organization and mobile number..

$ efa auth user add  --userName testabc --emailID testabc@gmail.com --password password 
--roles SystemAdmin  --organization Org --mobileNumber 9122424356

This example blocks a specified user.

$ efa auth user block-unblock --userName=testUser --isBlock=true

This example unblocks a specified user.

$ efa auth user block-unblock --userName=testUser --isBlock=false

This example resets a password for a specified user.

$ efa auth user reset-password --userName testabc 
--emailID testabc@gmail.com --password password123 

Successfully updated the user configuration. 

--- Time Elapsed: 2.69181206s ---

This example changes a password.

$ efa auth user change-password --oldPassword=test1234 --newPassword test456 

The password was changed successfully.  

--- Time Elapsed: 2.469497707s ---

This example deletes a specified user.

$ efa auth user delete --userName testabc 
                
Deleted User configuration successfully. 
                
--- Time Elapsed: 405.54142ms ---

This example lists active users with authentication type of HOST.

$ efa auth user show-active --authType=HOST 
                
+----------+-----------+-----------------------------------------+ 
                
| Username | Auth Type | Active Since                            | 
                
+----------+-----------+-----------------------------------------+ 
                
| anoop    | HOST      | 2022-03-07 10:01:52.094972524 +0530 IST | 
                
+----------+-----------+-----------------------------------------+